Don't fail for Razor: SymbolReference locations for @typeparam are misplaced by martin-strecker-sonarsource · Pull Request #8424 · SonarSource/sonar-dotnet

martin-strecker-sonarsource · 2023-11-29T14:43:09Z

The PR turns the hard failure into a log message.

martin-strecker-sonarsource · 2023-11-29T16:43:36Z

...library/src/main/java/org/sonarsource/dotnet/shared/plugins/protobuf/SymbolRefsImporter.java

+          }
+        } else if (declarationRange.get().overlap(referenceRange.get())) {
+          if (LOG.isDebugEnabled()) {
+            LOG.debug("The declaration token at {} overlaps with the referencing token {} in file {}", declarationRange.get(), referenceRange.get(), file.filename());


The actual fix.

what is the actual fix here? It's hard for me to follow what the difference is from the diff

It's the condition from the if statement: declarationRange.get().overlap(referenceRange.get()). If we add the range directly, the API we use (symbol.newReference) will throw.
So this check ensures that we log a warning (in debug) and continue the import ignoring the second range that is overlaping.

martin-strecker-sonarsource · 2023-11-29T16:44:31Z

...rary/src/test/java/org/sonarsource/dotnet/shared/plugins/protobuf/RazorImporterTestBase.java

+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.mock;
+
+public class RazorImporterTestBase {


New base class for all tests that interact with "src/test/resources/RazorProtobufImporter" files.

martin-strecker-sonarsource · 2023-11-29T16:46:35Z

...y/src/test/java/org/sonarsource/dotnet/shared/plugins/protobuf/RazorMetricsImporterTest.java

-        Tuple.tuple(CoreMetrics.CLASSES, 1),
-        Tuple.tuple(CoreMetrics.STATEMENTS, 15),
-        Tuple.tuple(CoreMetrics.FUNCTIONS, 4),
        Tuple.tuple(CoreMetrics.COMPLEXITY, 5),
+        Tuple.tuple(CoreMetrics.FUNCTIONS, 3),
        Tuple.tuple(CoreMetrics.COMMENT_LINES, 0),
        Tuple.tuple(CoreMetrics.COGNITIVE_COMPLEXITY, 1),
-        Tuple.tuple(CoreMetrics.NCLOC, 14));
+        Tuple.tuple(CoreMetrics.CLASSES, 0),
+        Tuple.tuple(CoreMetrics.NCLOC, 13),
+        Tuple.tuple(CoreMetrics.STATEMENTS, 6));


Some values changed, likely because the pd files were created new, and the old ones didn't fit "Cases.razor" or because the old ones were created with .Net 7 SDK and the new ones with .Net 8 SDK.

martin-strecker-sonarsource · 2023-11-30T09:22:36Z

...library/src/main/java/org/sonarsource/dotnet/shared/plugins/protobuf/SymbolRefsImporter.java

+    var referenceRange = toTextRange(file, refTextRange);
+    if (referenceRange.isEmpty()) {
+      if (LOG.isDebugEnabled()) {
+        LOG.debug("The reported token was out of the range. File {}, Range {}", file.filename(), refTextRange);


We lost coverage for that line because in the new pb, there is not "out of range" anymore (either fixed in .Net 8 SDK or fixed somewhere else).

They fixed the tab problem and we used tabs to reproduce that out-of-range issue.

sonarqubecloud · 2023-11-30T09:30:36Z

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

73.3% Coverage
0.0% Duplication

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

sonarqubecloud · 2023-11-30T09:37:26Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

sebastien-marichal

LGTM!

andrei-epure-sonarsource · 2023-12-01T14:33:43Z

sonar-dotnet-shared-library/src/test/resources/RazorProtobufImporter/log.pb

@@ -1 +1 @@
-Roslyn version: 4.6.0.0Language version: CSharp11!Concurrent execution: enabled��File 'C:\src\work\sonar-dotnet\its\projects\RazorMetrics\obj\Debug\net7.0\RazorMetrics.GlobalUsings.g.cs' was recognized as generated��File 'C:\src\work\sonar-dotnet\its\projects\RazorMetrics\obj\Debug\net7.0\.NETCoreApp,Version=v7.0.AssemblyAttributes.cs' was recognized as generated��File 'C:\src\work\sonar-dotnet\its\projects\RazorMetrics\obj\Debug\net7.0\RazorMetrics.AssemblyInfo.cs' was recognized as generated��File 'Microsoft.NET.Sdk.Razor.SourceGenerators\Microsoft.NET.Sdk.Razor.SourceGenerators.RazorSourceGenerator\Cases_razor.g.cs' was recognized as generated��File 'Microsoft.NET.Sdk.Razor.SourceGenerators\Microsoft.NET.Sdk.Razor.SourceGenerators.RazorSourceGenerator\_Imports_razor.g.cs' was recognized as generated
+Roslyn version: 4.8.0.0Language version: CSharp12!Concurrent execution: enabled��File 'Microsoft.NET.Sdk.Razor.SourceGenerators\Microsoft.NET.Sdk.Razor.SourceGenerators.RazorSourceGenerator\OverlapSymbolReferences_razor.g.cs' was recognized as razor generated��File 'Microsoft.NET.Sdk.Razor.SourceGenerators\Microsoft.NET.Sdk.Razor.SourceGenerators.RazorSourceGenerator\Cases_razor.g.cs' was recognized as razor generatedvrFile 'C:\Users\martin.strecker\Desktop\WebAss\obj\Debug\net8.0\WebAss.AssemblyInfo.cs' was recognized as generated��File 'C:\Users\martin.strecker\Desktop\WebAss\obj\Debug\net8.0\.NETCoreApp,Version=v8.0.AssemblyAttributes.cs' was recognized as generated


double check I understand well: did you recreate these PB files with .NET 8 @martin-strecker-sonarsource ?

Yes. I also added the csproj as part of the PR, so it is more easy to recreate the pb files (before, the csproj was missing):

sonar-dotnet/sonar-dotnet-shared-library/src/test/resources/RazorProtobufImporter/BlazorWebAssembly.csproj

Line 4 in 1f45892

<TargetFramework>net8.0</TargetFramework>

martin-strecker-sonarsource · 2023-12-05T13:44:34Z

Peach validation:
symbol references are still there when resolvable. See ariaPressedValue here:
https://peach.aws-prd.sonarsource.com/code?id=mudblazor&selected=mudblazor%3AMudBlazor%2FComponents%2FButton%2FMudToggleIconButton.razor

Other references work as well. See e.g. the Color property here:
https://peach.aws-prd.sonarsource.com/code?id=mudblazor&selected=mudblazor%3AMudBlazor%2FComponents%2FButton%2FMudFab.razor.cs

martin-strecker-sonarsource · 2023-12-06T10:39:46Z

@andrei-epure-sonarsource

For the second link, Color is in a C# file, right?
It's not in a razor file. Or am I missing something?

It's just a type and I do not know where it is defined. It is highly likely defined either in the project or in the framework. I just wanted to show that symbol references work for the properties in that "normal" C# file:

costin-zaharia-sonarsource · 2023-12-18T10:30:06Z

sonar-dotnet-shared-library/src/test/resources/RazorProtobufImporter/Program.cs

@@ -0,0 +1,6 @@
+namespace WebAss;


The first chars look strange. Is the encoding set correctly on the file?

costin-zaharia-sonarsource

LGTM!

Sorry, Martin, until now I only looked at the general picture which looked good.

I did not a complete review and I've noticed some small improvements. Up to you if you want to takle them or not.

costin-zaharia-sonarsource · 2023-12-18T10:32:03Z

...rc/test/java/org/sonarsource/dotnet/shared/plugins/protobuf/RazorSymbolRefsImporterTest.java

-      .build();
-    sensorContext.fileSystem().add(inputFile);
+  public void test_symbol_refs_get_imported_cases() {



pedantic: there is an empty line at the beginning of the tests that is not needed

costin-zaharia-sonarsource · 2023-12-18T10:35:26Z

...rc/test/java/org/sonarsource/dotnet/shared/plugins/protobuf/RazorSymbolRefsImporterTest.java

+  public void test_symbol_refs_get_imported_overlapSymbolReferences() {
+
+    var inputFile = OverlapSymbolReferencesInputFile;
+    var sut = new SymbolRefsImporter(sensorContext, s -> Paths.get(s).getFileName().toString());


var sut = new SymbolRefsImporter(sensorContext, RazorImporterTestBase::fileName);

costin-zaharia-sonarsource · 2023-12-18T10:37:26Z

...rc/test/java/org/sonarsource/dotnet/shared/plugins/protobuf/RazorSymbolRefsImporterTest.java

+    var sut = new SymbolRefsImporter(sensorContext, RazorImporterTestBase::fileName);
    sut.accept(protobuf.toPath());
    sut.save();


Creating the sut is duplicated (but slightly different), we should extract a function to create it.

martin-strecker-sonarsource added 4 commits November 29, 2023 13:03

WIP: Adopt test to support "real" pb files.

7010dca

Create Base class for Razor Importers

6a5d29b

Rename

1efc0f1

Refactor addReferences

7d13a76

github-actions bot assigned martin-strecker-sonarsource Nov 29, 2023

martin-strecker-sonarsource added 6 commits November 29, 2023 16:28

Add header

bd48e09

Better assertion

8bf0fcc

Formatting and "throws"

e09eb21

Add test_symbol_refs_get_imported_overlapSymbolReferences

2fc10fd

Extract "fileName"

8610ce4

Formatting

d88d8bb

martin-strecker-sonarsource changed the title ~~Symbol reference protobuf~~ Don't fail for Razor: SymbolReference locations for @typeparam are misplaced Nov 29, 2023

martin-strecker-sonarsource added 7 commits November 29, 2023 17:48

Rename file

442cdfb

Change readme

7eee3d8

Code smell

52b2d83

Extract method

6667539

Renamings

d5bcf35

Fix conditions

3fd86f5

Formatting

1f45892

martin-strecker-sonarsource marked this pull request as ready for review November 30, 2023 09:20

martin-strecker-sonarsource commented Nov 30, 2023

View reviewed changes

martin-strecker-sonarsource requested a review from sebastien-marichal November 30, 2023 09:23

github-actions bot assigned sebastien-marichal and unassigned martin-strecker-sonarsource Nov 30, 2023

martin-strecker-sonarsource added Bug Exceptions and blocking issues during analysis. Area: SQ Plugin labels Nov 30, 2023

sebastien-marichal approved these changes Nov 30, 2023

View reviewed changes

github-actions bot unassigned sebastien-marichal Nov 30, 2023

github-actions bot assigned martin-strecker-sonarsource Nov 30, 2023

martin-strecker-sonarsource requested a review from costin-zaharia-sonarsource November 30, 2023 14:31

github-actions bot assigned costin-zaharia-sonarsource and unassigned martin-strecker-sonarsource Nov 30, 2023

martin-strecker-sonarsource merged commit b30d0ac into master Nov 30, 2023

martin-strecker-sonarsource deleted the Martin/SymbolReferenceProtobuf branch November 30, 2023 16:54

andrei-epure-sonarsource reviewed Dec 1, 2023

View reviewed changes

martin-strecker-sonarsource assigned martin-strecker-sonarsource and unassigned costin-zaharia-sonarsource Dec 5, 2023

costin-zaharia-sonarsource reviewed Dec 18, 2023

View reviewed changes

dependabot bot mentioned this pull request Dec 29, 2025

Bump SonarAnalyzer.CSharp from 8.22.0.31243 to 10.17.0.131074 JeevanJames/IniFile#201

Closed

dependabot bot mentioned this pull request Jan 8, 2026

Bump SonarAnalyzer.CSharp from 8.22.0.31243 to 10.18.0.131500 JeevanJames/IniFile#202

Closed

dependabot bot mentioned this pull request Jan 30, 2026

Bump SonarAnalyzer.CSharp from 8.22.0.31243 to 10.19.0.132793 JeevanJames/IniFile#204

Closed

dependabot bot mentioned this pull request Feb 25, 2026

Bump SonarAnalyzer.CSharp from 8.22.0.31243 to 10.20.0.135146 JeevanJames/IniFile#207

Open

		@@ -1 +1 @@
		Roslyn version: 4.6.0.0Language version: CSharp11!Concurrent execution: enabled��File 'C:\src\work\sonar-dotnet\its\projects\RazorMetrics\obj\Debug\net7.0\RazorMetrics.GlobalUsings.g.cs' was recognized as generated��File 'C:\src\work\sonar-dotnet\its\projects\RazorMetrics\obj\Debug\net7.0\.NETCoreApp,Version=v7.0.AssemblyAttributes.cs' was recognized as generated��File 'C:\src\work\sonar-dotnet\its\projects\RazorMetrics\obj\Debug\net7.0\RazorMetrics.AssemblyInfo.cs' was recognized as generated��File 'Microsoft.NET.Sdk.Razor.SourceGenerators\Microsoft.NET.Sdk.Razor.SourceGenerators.RazorSourceGenerator\Cases_razor.g.cs' was recognized as generated��File 'Microsoft.NET.Sdk.Razor.SourceGenerators\Microsoft.NET.Sdk.Razor.SourceGenerators.RazorSourceGenerator\_Imports_razor.g.cs' was recognized as generated No newline at end of file
		Roslyn version: 4.8.0.0Language version: CSharp12!Concurrent execution: enabled��File 'Microsoft.NET.Sdk.Razor.SourceGenerators\Microsoft.NET.Sdk.Razor.SourceGenerators.RazorSourceGenerator\OverlapSymbolReferences_razor.g.cs' was recognized as razor generated��File 'Microsoft.NET.Sdk.Razor.SourceGenerators\Microsoft.NET.Sdk.Razor.SourceGenerators.RazorSourceGenerator\Cases_razor.g.cs' was recognized as razor generatedvrFile 'C:\Users\martin.strecker\Desktop\WebAss\obj\Debug\net8.0\WebAss.AssemblyInfo.cs' was recognized as generated��File 'C:\Users\martin.strecker\Desktop\WebAss\obj\Debug\net8.0\.NETCoreApp,Version=v8.0.AssemblyAttributes.cs' was recognized as generated No newline at end of file

Conversation

martin-strecker-sonarsource commented Nov 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andrei-epure-sonarsource Dec 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

costin-zaharia-sonarsource Dec 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Nov 30, 2023

Uh oh!

sonarqubecloud bot commented Nov 30, 2023

Uh oh!

sebastien-marichal left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

martin-strecker-sonarsource commented Dec 5, 2023

Uh oh!

martin-strecker-sonarsource commented Dec 6, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

costin-zaharia-sonarsource left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

martin-strecker-sonarsource commented Nov 29, 2023 •

edited

Loading

andrei-epure-sonarsource Dec 1, 2023 •

edited

Loading

costin-zaharia-sonarsource Dec 1, 2023 •

edited

Loading

costin-zaharia-sonarsource left a comment •

edited

Loading